Factory Actions

1. Click the search icon in the upper right corner of the page to open the Search Factory Actions dialog box:

2. Complete the fields as follows:

1. For Action Type, click one of the following options from the drop-down list:

• Reserve
• Manufacture or Provision (depends on your assigned user role)
• Validate

2. For Status, click the status of the factory action in the drop-down list:

• Success
• Failure

3. For Created By, enter the email of the user who initiated the factory action.
4. For Start Time From, click the start date in the pop-up calendar.
5. For Start Time To, click the end date in the pop-up calendar.

3. Click SEARCH.

1. Click the Factory Action you wish to view. This displays a list of all the devices that are part of the Factory Action on the DSN View tab:

2. Click the DSN of the device you wish to view. This displays the Device dialog box, which provides data on the Factory Action for that device:

3. Click the VIEW JOBS button to display the details of the Factory Action jobs for this device:

The reservation process depends on the type of device being manufactured: Ayla Wi-Fi Production Module (formerly called Black Box) or Ayla Integrated Agent (formerly called White Box). The Ayla Wi-Fi Production Module uses an Ayla module chosen by the manufacturing customer. The Ayla Integrated Agent uses a Linux distribution of the customer’s choice.

1. Click the RESERVE DSNS button to open the Reserve Devices dialog box:

2. For Model, click the model in the drop-down list.

3. Enter or use the up-down arrows to select the quantity to reserve.
4. Click the SUBMIT button to generate the following for each device:

• Device Serial Number (DSN)
• Private/public key pair (authenticates device with cloud service)

When the job is completed, a success banner displays on the user interface. The completed job results in an encrypted XML file available for download from the Factory Action tab under the Factory Action column for the corresponding device.

Three action files are created during the reservation process:

• CSV file - which is imported during the “Upload Manufacture” or “Upload Provision” function. The file contains a list of the DSNs recently uploaded.
• LOG file - which contains errors that occurred during the “Upload Manufacture” or “Upload Provision” function.
• XML file (zipped) - which contains the encrypted XML details of a reserved set of DSNs (example shown below).

Download the file as follows:

1. Click the file icon for Action files.
2. Move the file to a location on your computer.

The manufacture file has the following attributes:

• Version - the version of the log message format
• Time - the UTC time in seconds since 1 Jan, 1970
• Timestamp - the human-readable form of the time
• Status - status of action performed
• Err_code - whether configuration successfully loaded onto gateway
• Model - the model number of Ayla module
• DSN - the customer’s Device Serial Number
• MAC - unique hardware ID for device (usually set by manufacturer)
• mfg_sn - the hardware manufacturer’s model ID
• hwsig - the globally unique hardware identifier
• comment - the descriptive comment - must not contain commas

The upload process for the manufacturing file is as follows:

1. Click the UPLOAD MANUFACTURE FILE button.
2. Click the Browse button to locate and select the file.
3. Click the VALIDATE button, which checks the file to ensure correct information and formatting.
4. If there are errors found, click the log file to review it and then correct the upload file.
5. After validating, click SUBMIT.

The provision file is available to all customers, except module manufacturers. The file has the following attributes:

• Version - the version of the log message format
• Time - the UTC time in seconds since 1 Jan, 1970
• Timestamp - the human-readable form of the time
• Status - status of action performed
• Err_code - whether configuration successfully loaded onto gateway
• Model - the model number of Ayla module
• DSN - the customer’s Device Serial Number
• MAC - unique hardware ID for device (usually set by manufacturer)
• mfg_sn - the hardware manufacturer’s model ID
• hwsig - the globally unique hardware identifier
• comment - the descriptive comment - must not contain commas
• OEM ID - Ayla’s ID for the Ayla customer
• OEM Model - Ayla’s ID for Product Model
• module_sw_version - the module software version
• oem_host_version - OEM image version

The upload process for the provisioning file is as follows:

1. Click the UPLOAD PROVISION FILE button.

2. Click the Browse button to locate and select the file.
3. Click the VALIDATE button, which checks the file to ensure correct information and formatting.
4. If there are errors found, click the log file to review it and then correct the upload file.
5. After validating, click SUBMIT.

1. Click the DSN View tab.
2. Click the search icon in the upper right corner of the page to open the Search dialog box:

3. Complete the fields as follows:

1. For DSN, enter the customer’s Device Serial Number; you can use wildcards.
2. For Mac Address, enter the IP MAC address.
3. For Status, which is the DSN status, click one of the following options from the drop-down list:

• Reserved
• Manufactured
• Provisioned

2. For Errors, which is the type of response, click the status of the factory action in the drop-down list:

• Success
• Failure

3. For Ayla Model, enter the model number of Ayla module.
4. For Manufacturer Model, enter the manufacturer model name.
5. For Manufacturer SN, enter the manufacturer serial number.
6. For OEM Model, enter the model number of the customer’s host application board.
7. For OEM Host Version, enter the customer's host version number.
8. For Hardware Signature - enter the hardware identification.
9. For ADS Connect flag, click the flag in the drop-down list to show the device's connection with the Ayla Device Service (ADS):

• Yes (connected)
• No (not connected)

10. For ODM, enter the original device manufacturer.
11. For Model SW Version, enter the software version of the model.
12. For WiFi Setup Key, enter the setup key for Wi-Fi; you can use wildcards.
13. For Reserved After (UTC), enter the reserved after date/time in the pop-up calendar.
14. For Reserved Before (UTC), enter the reserved before date/time in the pop-up calendar.
15. For Manufactured After (UTC), enter the manufactured after date/time in the pop-up calendar.
16. For Manufactured Before (UTC), enter the manufactured before date/time in the pop-up calendar.
17. For Provisioned After (UTC), enter the provisioned after date/time in the pop-up calendar.
18. For Provisioned Before (UTC), enter the provisioned before date/time in the pop-up calendar.

4. Click SEARCH.

1. In the DNS View tab, click the device to open the Device dialog box:

2. To review the jobs for this device, click the VIEW JOBS button.

• The Factory Actions tab shows a list of jobs for the device.

• DSN View tab shows related device serial numbers (DSNs). You can click the DSN to open the Device dialog box showing just this device:

1. In the DNS View tab, click the device to open the Device dialog box:

2. Click FACTORY RESET. The Factory Reset Steps displays the result of the Device Factory Reset action on the Device dialog box (example shown below):

3. Notice the four actions that take place for the Factory Reset function:

• Reset Template
• Reset Device
• Unregister Device
• Reset the Datapoint

4. Click CLOSE when done.